block

Define a block that can be overridden by child templates. See Template inheritance for more information.

comment

Ignore everything between {% comment %} and {% endcomment %}

cycle

Cycle among the given strings each time this tag is encountered.

Within a loop, cycles among the given strings each time through the loop:

{% for o in some_list %}
    <tr class="{% cycle row1,row2 %}">
        ...
    </tr>
{% endfor %}

Outside of a loop, give the values a unique name the first time you call it, then use that name each successive time through:

<tr class="{% cycle row1,row2,row3 as rowcolors %}">...</tr>
<tr class="{% cycle rowcolors %}">...</tr>
<tr class="{% cycle rowcolors %}">...</tr>

You can use any number of values, separated by commas. Make sure not to put spaces between the values -- only commas.

debug

Output a whole load of debugging information, including the current context and imported modules.

extends

Signal that this template extends a parent template.

This tag may be used in two ways: {% extends "base" %} (with quotes) uses the literal value "base" as the name of the parent template to extend, or {% extends variable %} uses the value of variable as the name of the parent template to extend.

See Template inheritance for more information.

filter

Filter the contents of the variable through variable filters.

Filters can also be piped through each other, and they can have arguments -- just like in variable syntax.

Sample usage:

{% filter escape|lower %}
    This text will be HTML-escaped, and will appear in all lowercase.
{% endfilter %}

firstof

Outputs the first variable passed that is not False. Outputs nothing if all the passed variables are False.

Sample usage:

{% firstof var1 var2 var3 %}

This is equivalent to:

{% if var1 %}
    {{ var1 }}
{% else %}{% if var2 %}
    {{ var2 }}
{% else %}{% if var3 %}
    {{ var3 }}
{% endif %}{% endif %}{% endif %}

for

Loop over each item in an array. For example, to display a list of athletes given athlete_list:

<ul>
{% for athlete in athlete_list %}
    <li>{{ athlete.name }}</li>
{% endfor %}
</ul>

You can also loop over a list in reverse by using {% for obj in list reversed %}.

The for loop sets a number of variables available within the loop:

Variable	Description
forloop.counter	The current iteration of the loop (1-indexed)
forloop.counter0	The current iteration of the loop (0-indexed)
forloop.revcounter	The number of iterations from the end of the loop (1-indexed)
forloop.revcounter0	The number of iterations from the end of the loop (0-indexed)
forloop.first	True if this is the first time through the loop
forloop.last	True if this is the last time through the loop
forloop.parentloop	For nested loops, this is the loop "above" the current one

if

The {% if %} tag evaluates a variable, and if that variable is "true" (i.e. exists, is not empty, and is not a false boolean value) the contents of the block are output:

{% if athlete_list %}
    Number of athletes: {{ athlete_list|length }}
{% else %}
    No athletes.
{% endif %}

In the above, if athlete_list is not empty, the number of athletes will be displayed by the {{ athlete_list|length }} variable.

As you can see, the if tag can take an option {% else %} clause that will be displayed if the test fails.

if tags may use or or not to test a number of variables or to negate a given variable:

{% if not athlete_list %}
    There are no athletes.
{% endif %}

{% if athlete_list or coach_list %}
    There are some athletes or some coaches.
{% endif %}

{% if not athlete_list or coach_list %}
    There are no athletes or there are some coaches (OK, so
    writing English translations of boolean logic sounds
    stupid; it's not my fault).
{% endif %}

For simplicity, if tags do not allow and clauses; use nested if tags instead:

{% if athlete_list %}
    {% if coach_list %}
        Number of athletes: {{ athlete_list|length }}.
        Number of coaches: {{ coach_list|length }}.
    {% endif %}
{% endif %}

ifchanged

Check if a value has changed from the last iteration of a loop.

The 'ifchanged' block tag is used within a loop. It checks its own rendered contents against its previous state and only displays its content if the value has changed:

<h1>Archive for {{ year }}</h1>

{% for day in days %}
{% ifchanged %}<h3>{{ day|date:"F" }}</h3>{% endifchanged %}
<a href="{{ day|date:"M/d"|lower }}/">{{ day|date:"j" }}</a>
{% endfor %}

ifequal

Output the contents of the block if the two arguments equal each other.

Example:

{% ifequal user.id comment.user_id %}
    ...
{% endifequal %}

As in the {% if %} tag, an {% else %} clause is optional.

The arguments can be hard-coded strings, so the following is valid:

{% ifequal user.username "adrian" %}
    ...
{% endifequal %}

ifnotequal

Just like ifequal, except it tests that the two arguments are not equal.

include

Only available in Django development version.

Loads a template and renders it with the current context. This is a way of "including" other templates within a template.

The template name can either be a variable or a hard-coded (quoted) string, in either single or double quotes.

This example includes the contents of the template "foo/bar":

{% include "foo/bar" %}

This example includes the contents of the template whose name is contained in the variable template_name:

{% include template_name %}

An included template is rendered with the context of the template that's including it. This example produces the output "Hello, John":

• Context: variable person is set to "john".

• Template:

  {% include "name_snippet" %}
  

• The name_snippet template:

  Hello, {{ person }}
  

See also: {% ssi %}.

load

Load a custom template tag set.

See Custom tag and filter libraries for more information.

now

Display the date, formatted according to the given string.

Uses the same format as PHP's date() function (http://php.net/date) with some custom extensions.

Available format strings:

Format character	Description	Example output
a	'a.m.' or 'p.m.' (Note that this is slightly different than PHP's output, because this includes periods to match Associated Press style.)	'a.m.'
A	'AM' or 'PM'.	'AM'
B	Not implemented.
d	Day of the month, 2 digits with leading zeros.	'01' to '31'
D	Day of the week, textual, 3 letters.	'Fri'
f	Time, in 12-hour hours and minutes, with minutes left off if they're zero. Proprietary extension.	'1', '1:30'
F	Month, textual, long.	'January'
g	Hour, 12-hour format without leading zeros.	'1' to '12'
G	Hour, 24-hour format without leading zeros.	'0' to '23'
h	Hour, 12-hour format.	'01' to '12'
H	Hour, 24-hour format.	'00' to '23'
i	Minutes.	'00' to '59'
I	Not implemented.
j	Day of the month without leading zeros.	'1' to '31'
l	Day of the week, textual, long.	'Friday'
L	Boolean for whether it's a leap year.	True or False
m	Month, 2 digits with leading zeros.	'01' to '12'
M	Month, textual, 3 letters.	'Jan'
n	Month without leading zeros.	'1' to '12'
N	Month abbreviation in Associated Press style. Proprietary extension.	'Jan.', 'Feb.', 'March', 'May'
O	Difference to Greenwich time in hours.	'+0200'
P	Time, in 12-hour hours, minutes and 'a.m.'/'p.m.', with minutes left off if they're zero and the special-case strings 'midnight' and 'noon' if appropriate. Proprietary extension.	'1 a.m.', '1:30 p.m.', 'midnight', 'noon', '12:30 p.m.'
r	RFC 822 formatted date.	'Thu, 21 Dec 2000 16:01:07 +0200'
s	Seconds, 2 digits with leading zeros.	'00' to '59'
S	English ordinal suffix for day of the month, 2 characters.	'st', 'nd', 'rd' or 'th'
t	Number of days in the given month.	28 to 31
T	Time zone of this machine.	'EST', 'MDT'
U	Not implemented.
w	Day of the week, digits without leading zeros.	'0' (Sunday) to '6' (Saturday)
W	ISO-8601 week number of year, with weeks starting on Monday.	1, 23
y	Year, 2 digits.	'99'
Y	Year, 4 digits.	'1999'
z	Day of the year.	0 to 365
Z	Time zone offset in seconds. The offset for timezones west of UTC is always negative, and for those east of UTC is always positive.	-43200 to 43200

Example:

It is {% now "jS F Y H:i" %}

Note that you can backslash-escape a format string if you want to use the "raw" value. In this example, "f" is backslash-escaped, because otherwise "f" is a format string that displays the time. The "o" doesn't need to be escaped, because it's not a format character.:

It is the {% "jS o\f F" %}

(Displays "It is the 4th of September" %}

regroup

Regroup a list of alike objects by a common attribute.

This complex tag is best illustrated by use of an example: say that people is a list of Person objects that have first_name, last_name, and gender attributes, and you'd like to display a list that looks like:

• Male:

  • George Bush
  • Bill Clinton

• Female:

  • Margaret Thatcher
  • Condoleezza Rice

• Unknown:

  • Pat Smith

The following snippet of template code would accomplish this dubious task:

{% regroup people by gender as grouped %}
<ul>
{% for group in grouped %}
    <li>{{ group.grouper }}
    <ul>
        {% for item in group.list %}
        <li>{{ item }}</li>
        {% endfor %}
    </ul>
{% endfor %}
</ul>

As you can see, {% regroup %} populates a variable with a list of objects with grouper and list attributes. grouper contains the item that was grouped by; list contains the list of objects that share that grouper. In this case, grouper would be Male, Female and Unknown, and list is the list of people with those genders.

Note that {% regroup %} does not work when the list to be grouped is not sorted by the key you are grouping by! This means that if your list of people was not sorted by gender, you'd need to make sure it is sorted before using it, i.e.:

{% regroup people|dictsort:"gender" by gender as grouped %}

ssi

Output the contents of a given file into the page.

Like a simple "include" tag, {% ssi %} includes the contents of another file -- which must be specified using an absolute path -- in the current page:

{% ssi /home/html/ljworld.com/includes/right_generic.html %}

If the optional "parsed" parameter is given, the contents of the included file are evaluated as template code, within the current context:

{% ssi /home/html/ljworld.com/includes/right_generic.html parsed %}

Note that if you use {% ssi %}, you'll need to define ALLOWED_INCLUDE_ROOTS in your Django settings, as a security measure.

See also: {% include %}.

templatetag

Output one of the syntax characters used to compose template tags.

Since the template system has no concept of "escaping", to display one of the bits used in template tags, you must use the {% templatetag %} tag.

The argument tells which template bit to output:

Argument	Outputs
openblock	{%
closeblock	%}
openvariable	{{
closevariable	}}

widthratio

For creating bar charts and such, this tag calculates the ratio of a given value to a maximum value, and then applies that ratio to a constant.

For example:

<img src='bar.gif' height='10' width='{% widthratio this_value max_value 100 %}' />

Above, if this_value is 175 and max_value is 200, the the image in the above example will be 88 pixels wide (because 175/200 = .875; .875 * 100 = 87.5 which is rounded up to 88).

add

Adds the arg to the value.

addslashes

Adds slashes. Useful for passing strings to JavaScript, for example.

capfirst

Capitalizes the first character of the value.

center

Centers the value in a field of a given width.

cut

Removes all values of arg from the given string.

date

Formats a date according to the given format (same as the now tag).

default

If value is unavailable, use given default.

default_if_none

If value is None, use given default.

dictsort

Takes a list of dicts, returns that list sorted by the property given in the argument.

dictsortreversed

Takes a list of dicts, returns that list sorted in reverse order by the property given in the argument.

divisibleby

Returns true if the value is divisible by the argument.

escape

Escapes a string's HTML. Specifically, it makes these replacements:

• "&" to "&"
• < to "&lt;"
• > to "&gt;"
• '"' (double quote) to "&quot;"

filesizeformat

Format the value like a 'human-readable' file size (i.e. 13 KB, 4.1 MB, 102 bytes, etc).

first

Returns the first item in a list.

fix_ampersands

Replaces ampersands with &amp; entities.

floatformat

Rounds a floating-point number to one decimal place -- but only if there's a decimal part to be displayed. For example:

• 36.123 gets converted to 36.1
• 36.15 gets converted to 36.2
• 36 gets converted to 36

get_digit

Given a whole number, returns the requested digit of it, where 1 is the right-most digit, 2 is the second-right-most digit, etc. Returns the original value for invalid input (if input or argument is not an integer, or if argument is less than 1). Otherwise, output is always an integer.

join

Joins a list with a string, like Python's str.join(list).

length

Returns the length of the value. Useful for lists.

length_is

Returns a boolean of whether the value's length is the argument.

linebreaks

Converts newlines into <p> and <br />s.

linebreaksbr

Converts newlines into <br />s.

linenumbers

Displays text with line numbers.

ljust

Left-aligns the value in a field of a given width.

Argument: field size

lower

Converts a string into all lowercase.

make_list

Returns the value turned into a list. For an integer, it's a list of digits. For a string, it's a list of characters.

phone2numeric

Converts a phone number to its numerical equivalent.

pluralize

Returns 's' if the value is not 1, for '1 vote' vs. '2 votes'.

pprint

A wrapper around pprint.pprint -- for debugging, really.

random

Returns a random item from the list.

removetags

Removes a space separated list of [X]HTML tags from the output.

rjust

Right-aligns the value in a field of a given width.

Argument: field size

slice

Returns a slice of the list.

Uses the same syntax as Python's list slicing. See http://diveintopython.org/native_data_types/lists.html#odbchelper.list.slice for an introduction.

Example: {{ some_list|slice:":2" }}

slugify

Converts to lowercase, removes non-word characters (alphanumerics and underscores) and converts spaces to hyphens. Also strips leading and trailing whitespace.

stringformat

Formats the variable according to the argument, a string formatting specifier. This specifier uses Python string formating syntax, with the exception that the leading "%" is dropped.

See http://docs.python.org/lib/typesseq-strings.html for documentation of Python string formatting

striptags

Strips all [X]HTML tags.

time

Formats a time according to the given format (same as the now tag).

timesince

Formats a date as the time since that date (i.e. "4 days, 6 hours").

title

Converts a string into titlecase.

truncatewords

Truncates a string after a certain number of words.

Argument: Number of words to truncate after

unordered_list

Recursively takes a self-nested list and returns an HTML unordered list -- WITHOUT opening and closing <ul> tags.

The list is assumed to be in the proper format. For example, if var contains ['States', [['Kansas', [['Lawrence', []], ['Topeka', []]]], ['Illinois', []]]], then {{ var|unordered_list }} would return:

<li>States
<ul>
        <li>Kansas
        <ul>
                <li>Lawrence</li>
                <li>Topeka</li>
        </ul>
        </li>
        <li>Illinois</li>
</ul>
</li>

upper

Converts a string into all uppercase.

urlencode

Escapes a value for use in a URL.

urlize

Converts URLs in plain text into clickable links.

urlizetrunc

Converts URLs into clickable links, truncating URLs to the given character limit.

Argument: Length to truncate URLs to

wordcount

Returns the number of words.

wordwrap

Wraps words at specified line length.

Argument: number of words at which to wrap the text

yesno

Given a string mapping values for true, false and (optionally) None, returns one of those strings according to the value: